docs: document GitHub template workflow#6
Conversation
📝 WalkthroughWalkthroughThis pull request updates documentation across the repository to establish comprehensive GitHub template usage guidance. Changes clarify the repository's role as a reference template baseline, introduce a new GitHub template creation guide with agent instructions, expand existing documentation and quickstart workflows, and update agent/skill processes to handle template-generated repositories. ChangesGitHub Template Usage and Guidance
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Documents how to use 508 Devkit as a GitHub template repository, emphasizing that template-generated repos should do an initial “template selection pass” to prune irrelevant stacks/extras/docs/workflows before feature work.
Changes:
- Adds guidance across README + agent docs to treat GitHub template-generated repos as a bootstrap workspace requiring an initial cleanup PR.
- Introduces a dedicated cleanup/checklist doc:
docs/github-template.md. - Aligns the bundled
skills/508-devkitskill and walkthrough docs with the same template-selection workflow.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/508-devkit/SKILL.md | Adds template-generated repo guidance and a cleanup step in the workflow. |
| README.md | Updates quickstart with “Create from template” flow and links to the new checklist doc. |
| docs/template-proposal.md | Documents “GitHub Template Mode” and the initial selection/pruning expectation. |
| docs/interfaces.md | Adds template usage as a first-class repo interface + selection-pass guidance. |
| docs/github-template.md | New checklist doc describing the intended template generation + pruning workflow. |
| docs/agent-walkthrough.md | Adds a template-specific prompt and includes pruning as an explicit agent step. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| When used as a GitHub template repository, the first generated-repo change | ||
| should be a selection pass. GitHub copies the default branch file tree, so users | ||
| and agents must prune unselected stacks, extras, example apps, and design-history |
| - Evolving scripts, CI, docs, and examples through normal PRs. | ||
| - Letting any agent or human inspect the same artifact. | ||
|
|
||
| GitHub's template button copies the default branch file tree. That is a useful |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/agent-walkthrough.md`:
- Around line 28-30: Update the template-cleanup instructions in Step 6 of
docs/agent-walkthrough.md to explicitly include deleting unselected "workflows"
(CI workflow files) along with stacks, extras, example app names, and docs so it
matches the template-selection flow described in docs/github-template.md; change
the wording in the Step 6 text to mention "workflows" so generated repos do not
retain irrelevant CI files.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: ddf9d3d8-707b-45ad-8255-bed6e81876fd
📒 Files selected for processing (6)
README.mddocs/agent-walkthrough.mddocs/github-template.mddocs/interfaces.mddocs/template-proposal.mdskills/508-devkit/SKILL.md
| 6. If the repo was generated from the GitHub template, delete unselected stacks, | ||
| extras, example app names, and docs that do not describe the target project. | ||
| 7. Run focused validation. |
There was a problem hiding this comment.
Include “workflows” in the template-cleanup step for consistency.
Step 6 omits workflows, but the template-selection flow in docs/github-template.md explicitly includes deleting unselected placeholder workflows. This mismatch can cause generated repos to keep irrelevant CI files.
Suggested wording update
-6. If the repo was generated from the GitHub template, delete unselected stacks,
- extras, example app names, and docs that do not describe the target project.
+6. If the repo was generated from the GitHub template, delete unselected stacks,
+ extras, workflows, example app names, and docs that do not describe the
+ target project.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 6. If the repo was generated from the GitHub template, delete unselected stacks, | |
| extras, example app names, and docs that do not describe the target project. | |
| 7. Run focused validation. | |
| 6. If the repo was generated from the GitHub template, delete unselected stacks, | |
| extras, workflows, example app names, and docs that do not describe the | |
| target project. | |
| 7. Run focused validation. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/agent-walkthrough.md` around lines 28 - 30, Update the template-cleanup
instructions in Step 6 of docs/agent-walkthrough.md to explicitly include
deleting unselected "workflows" (CI workflow files) along with stacks, extras,
example app names, and docs so it matches the template-selection flow described
in docs/github-template.md; change the wording in the Step 6 text to mention
"workflows" so generated repos do not retain irrelevant CI files.
Summary
Notes
508-dev/508-devkitrepository setting has already been marked as a GitHub template repository; this PR documents the intended workflow in the repo contents.Validation
./scripts/check-all.shgit diff --checkRisk
Screenshots
Not applicable.
Summary by CodeRabbit
Release Notes